Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(storybook): update documentation to the latest versions available for pnpm installation #7953

Merged

Conversation

javiev
Copy link
Contributor

@javiev javiev commented Apr 14, 2024

For pnpm installation

Description

Starting a project with TurboRepo, Storybook 8+, and Next.js 14 with App Router, I encountered issues using the current guides, which prevented an effective installation. This fork aims to update the documentation to address these issues, providing clear, updated steps for a successful installation of these technologies. Evidence of initial challenges and positive outcomes following the suggested documentation adjustments are included, making the process smoother for future users.

I hope the suggested changes prove useful to the community. I'd like to thank the Vercel development team for providing us with powerful and innovative tools, facilitating the advancement of our projects with cutting-edge technology.

Testing Instructions

In the project development process, the first issue emerged when using pnpm dlx sb init --skip-install, leading to complications. To tackle a second issue regarding dependencies, "ui": "workspace:*" was replaced with "@repo/ui": "workspace:*", modifying the declaration approach. For the third issue, importing components was adjusted from import { Button } from 'ui' to import { Button } from '@repo/ui/button', solving import problems. These suggested changes showcased an improvement in the final results.

Using pnpm dlx sb init --skip-install led to the first issue.

SCR-20240413-plba

Replacing "ui": "workspace:" with "@repo/ui": "workspace:" addressed a dependency problem.

before

SCR-20240413-posk

after

SCR-20240413-ppbd

Changing imports from import { Button } from 'ui' to import { Button } from '@repo/ui/button' fixed import issues.

before

SCR-20240413-ppiz

after

SCR-20240413-pppz

Final Outcome: The implementation of these changes led to a successful setup and integration.

SCR-20240413-psgm

@javiev javiev requested review from anthonyshew and a team as code owners April 14, 2024 00:59
@javiev javiev requested a review from gsoltis April 14, 2024 00:59
@turbo-orchestrator turbo-orchestrator bot added area: docs Improvements or additions to documentation owned-by: turborepo labels Apr 14, 2024
Copy link

vercel bot commented Apr 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
examples-basic-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-designsystem-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-gatsby-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-kitchensink-blog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-native-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-svelte-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-tailwind-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
examples-vite-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 6:36pm
turbo-turbo-tracing-next-plugin ❌ Failed (Inspect) Apr 16, 2024 6:36pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
rust-docs ⬜️ Ignored (Inspect) Visit Preview Apr 16, 2024 6:36pm

Copy link

vercel bot commented Apr 14, 2024

@javiev is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@anthonyshew
Copy link
Contributor

Thanks for this update!

It looks like a merge conflict has come up due to another community PR. Could you fix that up and then I can approve and we can merge?

@javiev
Copy link
Contributor Author

javiev commented Apr 14, 2024

@anthonyshew conflict fixed, please review again!

Copy link
Contributor

@anthonyshew anthonyshew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thank you!

@ijjk
Copy link
Member

ijjk commented Apr 16, 2024

Allow CI Workflow Run

  • approve CI run for commit: 6680be7

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants